<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OpenShoe: Sleep manager</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">OpenShoe
   &#160;<span id="projectnumber">0.1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">Sleep manager</div>  </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleepmgr__group.html#gad8e649a9d53092c580960f2f9886ee98">CONFIG_SLEEPMGR_ENABLE</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration symbol for enabling the sleep manager.  <a href="#gad8e649a9d53092c580960f2f9886ee98"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleepmgr__group.html#gaa990bc3ea16fcad09009cdc70dbc38c6">sleepmgr_mode</a> { <br/>
&#160;&#160;<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6a04a2ceb6fc138cae84e9334cfa90d89f">SLEEPMGR_ACTIVE</a>, 
<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6ae4f3742b3532d5ebabef6f26fabf4487">SLEEPMGR_IDLE</a>, 
<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6a07fe232646cccb4c2b9e0ba301866cb9">SLEEPMGR_FROZEN</a>, 
<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6affb1e224bd127ccf5c7b54a54c3ba665">SLEEPMGR_STDBY</a>, 
<br/>
&#160;&#160;<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6a84505afbeafb45b0c9e9b5fc1a1e3e5e">SLEEPMGR_STOP</a>, 
<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6a6ee894e3a9dc55e678d10a9cebff5dd1">SLEEPMGR_DEEPSTOP</a>, 
<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6adbc00d523bb40feb59822bfbec8106c4">SLEEPMGR_STATIC</a>, 
<a class="el" href="group__sleepmgr__group.html#ggaa990bc3ea16fcad09009cdc70dbc38c6a02fd0aaf6162fa103be2aa0b2593a984">SLEEPMGR_NR_OF_MODES</a>
<br/>
 }</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep mode locks.  <a href="group__sleepmgr__group.html#gaa990bc3ea16fcad09009cdc70dbc38c6">More...</a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The sleep manager is a service for ensuring that the device is not put to sleep in deeper sleep modes than the system (e.g., peripheral drivers, services or the application) allows at any given time.</p>
<p>It is based on the use of lock counting for the individual sleep modes, and will put the device to sleep in the shallowest sleep mode that has a non-zero lock count. The drivers/services/application can change these counts by use of sleepmgr_lock_mode and sleepmgr_unlock_mode. Refer to <a class="el" href="group__sleepmgr__group.html#gaa990bc3ea16fcad09009cdc70dbc38c6">sleepmgr_mode</a> for a list of the sleep modes available for locking, and the device datasheet for information on their effect.</p>
<p>The application must supply the file <a class="el" href="conf__sleepmgr_8h.html">conf_sleepmgr.h</a>.</p>
<p>For the sleep manager to be enabled, the symbol <a class="el" href="group__sleepmgr__group.html#gad8e649a9d53092c580960f2f9886ee98">CONFIG_SLEEPMGR_ENABLE</a> must be defined, e.g., in <a class="el" href="conf__sleepmgr_8h.html">conf_sleepmgr.h</a>. If this symbol is not defined, the functions are replaced with dummy functions and no RAM is used. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gad8e649a9d53092c580960f2f9886ee98"></a><!-- doxytag: member="conf_sleepmgr.h::CONFIG_SLEEPMGR_ENABLE" ref="gad8e649a9d53092c580960f2f9886ee98" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CONFIG_SLEEPMGR_ENABLE</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Configuration symbol for enabling the sleep manager. </p>
<p>If this symbol is not defined, the functions of this service are replaced with dummy functions. This is useful for reducing code size and execution time if the sleep manager is not needed in the application.</p>
<p>This symbol may be defined in <a class="el" href="conf__sleepmgr_8h.html">conf_sleepmgr.h</a>. </p>

</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gaa990bc3ea16fcad09009cdc70dbc38c6"></a><!-- doxytag: member="uc3/sleepmgr.h::sleepmgr_mode" ref="gaa990bc3ea16fcad09009cdc70dbc38c6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__sleepmgr__group.html#gaa990bc3ea16fcad09009cdc70dbc38c6">sleepmgr_mode</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sleep mode locks. </p>
<p>Identifiers for the different sleep mode locks. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6a04a2ceb6fc138cae84e9334cfa90d89f"></a><!-- doxytag: member="SLEEPMGR_ACTIVE" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6a04a2ceb6fc138cae84e9334cfa90d89f" args="" -->SLEEPMGR_ACTIVE</em>&nbsp;</td><td>
<p>Active mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6ae4f3742b3532d5ebabef6f26fabf4487"></a><!-- doxytag: member="SLEEPMGR_IDLE" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6ae4f3742b3532d5ebabef6f26fabf4487" args="" -->SLEEPMGR_IDLE</em>&nbsp;</td><td>
<p>Idle mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6a07fe232646cccb4c2b9e0ba301866cb9"></a><!-- doxytag: member="SLEEPMGR_FROZEN" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6a07fe232646cccb4c2b9e0ba301866cb9" args="" -->SLEEPMGR_FROZEN</em>&nbsp;</td><td>
<p>Frozen mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6affb1e224bd127ccf5c7b54a54c3ba665"></a><!-- doxytag: member="SLEEPMGR_STDBY" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6affb1e224bd127ccf5c7b54a54c3ba665" args="" -->SLEEPMGR_STDBY</em>&nbsp;</td><td>
<p>Standby mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6a84505afbeafb45b0c9e9b5fc1a1e3e5e"></a><!-- doxytag: member="SLEEPMGR_STOP" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6a84505afbeafb45b0c9e9b5fc1a1e3e5e" args="" -->SLEEPMGR_STOP</em>&nbsp;</td><td>
<p>Stop mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6a6ee894e3a9dc55e678d10a9cebff5dd1"></a><!-- doxytag: member="SLEEPMGR_DEEPSTOP" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6a6ee894e3a9dc55e678d10a9cebff5dd1" args="" -->SLEEPMGR_DEEPSTOP</em>&nbsp;</td><td>
<p>Deep Stop mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6adbc00d523bb40feb59822bfbec8106c4"></a><!-- doxytag: member="SLEEPMGR_STATIC" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6adbc00d523bb40feb59822bfbec8106c4" args="" -->SLEEPMGR_STATIC</em>&nbsp;</td><td>
<p>Static mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa990bc3ea16fcad09009cdc70dbc38c6a02fd0aaf6162fa103be2aa0b2593a984"></a><!-- doxytag: member="SLEEPMGR_NR_OF_MODES" ref="ggaa990bc3ea16fcad09009cdc70dbc38c6a02fd0aaf6162fa103be2aa0b2593a984" args="" -->SLEEPMGR_NR_OF_MODES</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 19 2011 21:04:54 for OpenShoe by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
